TimePunch Licensing Service
Der Licensing Service kann dazu benutzt werden, um Lizenzdaten für Benutzer zu hinterlegen.
AddLicense
Mit dieser Methode kann eine TimePunch Lizenz zur internen Lizenzverwaltung hinzugefügt werden.
ApplicationLicenseDto AddLicense(
out TpFault fault,
TpAuthentication authentication,
string[] applicationKeys,
string licensedFor,
string licenseCode);
| Needed Permission | core@logon | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| applicationKeys | Specifies the application to add the license | |
| licensedFor | License Name | |
| licenseCode | License Code | |
| return value | Information about the currently added license |
ExchangeLicense
Diese Methode tauscht eine bestehende Lizenz gegen eine neue Lizenz aus. Das kann bei Upgrades hilfreich sein, wenn die alte Lizenz nicht mehr benötigt wird, aber die Mitarbeiter eins zu eins der neuen Lizenz zugeordnet werden sollen.
ApplicationLicenseDto ExchangeLicense(
out TpFault fault,
TpAuthentication authentication,
string[] applicationKeys,
Guid applicationLicenseId,
string licensedFor,
string licenseCode);
| Needed Permission | licenses@manage | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| applicationKeys | Specifies the application to add the license | |
| applicationLicenseId | Old application license id to remove | |
| licensedFor | License Name | |
| licenseCode | License Code | |
| return value | Information about the currently added license |
GetApplicationLicenses
Diese Methode liefert die Applikationslizenzen für die übergebenen Applikationsschlüssel zurück.
ApplicationLicenseDto[] GetApplicationLicenses(
out TpFault fault,
TpAuthentication authentication,
string[] applicationKeys);
| Needed Permission | core@logon | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| applicationKeys | Specifies the application to retrieve license information for. | |
| return value | Application specific license information |
GetLicensingState
Diese Methode prüft die Lizenzierung eines einzelnen Mitarbeiters. Wichtig dabei ist auch die Angabe nach welchen Lizenzen gesucht werden soll. Dies wird durch den Parameter ApplicationKeys festgelegt. Zurückgegeben wird der tatsächlich lizenzierte Application Key. Beispiel, es wird eine Lizenz für TimePunch PRO und PZE Watcher gesucht. Wenn der Mitarbeiter den PZE Watcher lizenziert hat, dann wird der Application Key für den Watcher zurückgeliefert.
LicensingState GetLicensingState(
out TpFault fault,
TpAuthentication authentication,
string[] applicationKeys,
out int daysLeft,
out string applicationKey);
| Needed Permission | core@logon | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| applicationKeys | Specifies the application to retrieve license information for. | |
| daysLeft | Out | Defines how many days the license will be valid. |
| applicationKey | Out | Gets the application key for that the user owns a specific license. |
| return value | Gets the licensing state of the user NoLicense, TestLicenseFound, TestLicenseExpired, LicenseFound, LicenseExpired, Undefined |
IsLicenseUpgradeNeeded
Diese Methode prüft, ob die bestehenden Lizenzen auf eine neue Version von TimePunch aktualisiert werden müssen. Dies ist vor allem bei versionsgebundenen Lizenzen von Interesse, da diese Lizenzen nur für eine bestimmte Version gültig sind.
bool IsLicenseUpgradeNeeded(
out TpFault fault,
TpAuthentication authentication,
string[] applicationKeys,
string version);
| Needed Permission | --- | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| applicationKeys | Specifies the application to retrieve license information for. | |
| version | Version that shall be tested. | |
| return value | True, if the current license is upgradable. E.g. the current version is 2.95 – the new version will be 3.2 which will than result in true as the return value. |
RequestUpgradeOffer
Wenn das Ergebnis der Upgradeprüfung true ergibt (IsLicenseUpgradeable) dann kann mit dieser Methode ein Angebot zum Versionsupgrade eingeholt werden. Die Methode connected sich mit TimePunch und übergibt die Lizenzdaten damit ein individuelles Upgrade Angebot zugesendet werden kann.
RequestOfferResult RequestUpgradeOffer(
out TpFault fault,
TpAuthentication authentication,
string[] applicationKeys,
RequestUpgradeOfferDto requestUpgradeOffer);
| Needed Permission | --- | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| applicationKeys | Specifies the application to retrieve license information for. | |
| requestUpgradeOffer | Customer data used to send the upgrade offer | |
| Return value | Result of the upgrade offer request Error, NoUpgradeNecessary, AutomaticOffer, ManualOffer |
GetUserLicenses
Diese Methode liefert alle Lizenzdaten für die im Suchobjekt spezifizierten Mitarbeiter zurück. Wichtig dabei ist auch die Angabe nach welchen Lizenzen gesucht werden soll. Dies wird durch den Parameter ApplicationKeys festgelegt.
UserLicenseDto[] GetUserLicenses(
out TpFault fault,
TpAuthentication authentication,
string[] applicationKeys,
UserSearchDto searchDto);
| Needed Permission | core@logon | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| applicationKeys | Specifies the application to retrieve license information for. | |
| searchDto | Search object to specify the users for loading the license data. | |
| return value | User specific license information |
RemoveLicenses
Mit Hilfe dieser Methode können bereits eingefügte Applikationslizenzen wieder entfernt werden.
void RemoveLicenses(
out TpFault fault,
TpAuthentication authentication,
string[] applicationKeys,
Guid[] applicationLicenseIds);
| Needed Permission | licenses@manage | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| applicationKeys | Specifies the application to register the user | |
| applicationLicenseIds | List containing the application license ids that shall be removed for the given application keys. |
RegisterUsers
Diese Methode versucht die angegebenen Mitarbeiterprofile für die im Parameter applicationKeys spezifizierten Applikationen zu registrieren. Dies funktioniert nur dann, wenn für den Mitarbeiter noch Lizenzen verfügbar sind.
void RegisterUsers(
out TpFault fault,
TpAuthentication authentication,
string[] applicationKeys,
List<Guid> userIds);
| Needed Permission | core@logon | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| applicationKeys | Specifies the application to register the user | |
| userIds | List containing the user ids that shall be registered for the given application keys. |
UnregisterUsers
Diese Methode entfernt die Lizenzinformationen eines Mitarbeiters. Dabei werden nur die Lizenzen für die Applikationen entfernt, die im Parameter applicationKeys angegeben sind.
void UnregisterUsers(
out TpFault fault,
TpAuthentication authentication,
string[] applicationKeys,
List<Guid> userIds);
| Needed Permission | core@logon | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| applicationKeys | Specifies the application to un-register the user | |
| userIds | List containing the user ids that shall be un-registered for the given application keys. |